Add documentation for adding Maven dependencies #399
Conversation
github-actions
bot
added
priority/major
|
@Shekharrajak Please add the following content to your PR description and select a checkbox: |
github-actions
bot
added
doc-not-needed
|
Hi, @Shekharrajak, thanks for your contribution. I think this document is very detailed and specific, thank you for your hard work. However, we might not want to dedicate such a long section to covering all dependency details. Instead, we could briefly introduce, in the section like "Installation," which artifacts users should depend on when developing Agent applications based on flink-agents (api + integration). Also, what additional dependencies are needed if one wants to run it in an IDE. (runtime + flink artifacts) WDYT? |
|
Thanks @wenjin272 for the review. Check the new commit : 891f52f |
|
|
||
| **Required for developing Agent applications:** | ||
| - `flink-agents-api` - Core API interfaces and classes | ||
| - Integration modules - Add the specific integrations you need (e.g., `flink-agents-integrations-chat-models-openai`) |
There was a problem hiding this comment.
In #433, we add constant strings to point a resource implementation, so integration modules is not required for developing. But they are still need for running in IDE
|
Hi, @xintongsong, could you help review this PR? Due to our recent changes to the API, one part of the documentation needs to be updated accordingly. However, since @Shekharrajak has not responded recently, we can make this update separately after merging this PR. |
xintongsong
added
doc-included
| <!-- Runtime (required for IDE/local execution) --> | ||
| <dependency> | ||
| <groupId>org.apache.flink</groupId> | ||
| <artifactId>flink-agents-runtime</artifactId> | ||
| <version>${flink-agents.version}</version> | ||
| </dependency> |
There was a problem hiding this comment.
Should this also be provided?
| {{< hint info >}} | ||
| **Note:** Replace `0.2-SNAPSHOT` with the actual release version when available. For SNAPSHOT versions, you may need to add the Apache snapshot repository to your `pom.xml`. | ||
| {{< /hint >}} |
There was a problem hiding this comment.
I think we can remove this hint and just use 0.2 w/o the -SNAPSHOT suffix. The version will soon be available in 1-2 weeks.
| <scope>provided</scope> | ||
| </dependency> | ||
| </dependencies> | ||
| ``` |
There was a problem hiding this comment.
I have a feeling that there are too many dependencies need to be added for execution in an IDE. This not only harms the user experience, but also makes this document hard to maintain as the dependencies need to be added may change in future and this document can easily become inconsistent. I wonder if we can introduce a pom like flink-agents-ide-supports, which includes all dependencies needed for the local execution. Of course this can be a separate issue and should not block this PR.
cc @wenjin272
3 participants
Ref #393
doc-neededdoc-not-needed